/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsr;

import java.util.Calendar;
import java.util.Hashtable;

import org.apache.xmlbeans.GDuration;

import cgl.narada.wsinfra.schemas.wsr.PollRequestDocument;
import cgl.narada.wsinfra.schemas.wsr.RequestDocument;
import cgl.narada.wsinfra.schemas.wsr.ResponseDocument;

/** This is a class which facilitates the creation of WSR elements that
    are added to SOAP Envelope

    @author Sima Patel
    $Date: 2005/04/01 19:04:16 $
    $Revision: 1.4 $
*/

public interface WsrElementCreation {
  
    /** Creates a Request Document based on the specified mandatory parameters 
    This creates a request for PollRequest and Response RM reply pattern*/
    public RequestDocument newRequest(String groupId, long sequenceNumber,
                                      boolean lastMessage, 
                                      Calendar messageExpiryTime,
                                      String replyPatternName);
  
    /** Creates a Request Document based on the specified mandatory parameters 
    This creates a request for Callback RM reply pattern */
    public RequestDocument newRequest(String groupId, long sequenceNumber,
                                      boolean lastMessage, 
                                      Calendar messageExpiryTime, 
                                      String replyPatternName, String replyTo);
  
    /** Creates a Request Document based on the specified mandatory parameters 
    with some optional parameters This creates a request for PollRequest and 
    Response RM reply pattern*/
    public RequestDocument newRequest(String groupId, Calendar groupExpiryTime, 
                                      long sequenceNumber, boolean lastMessage, 
                                      Calendar messageExpiryTime, 
                                      String replyPatternName);
   
    /** Creates a Request Document based on the specified mandatory parameters 
    with some optional parameters This creates a request for PollRequest and 
    Response RM reply pattern*/
  
    public RequestDocument newRequest(String groupId, 
                                      GDuration groupMaxIdleDuration, 
                                      long sequenceNumber,
                                      boolean lastMessage, 
                                      Calendar messageExpiryTime, 
                                      String replyPatternName);
  
    /** Creates a Request Document based on the specified mandatory 
    parameters with some optional parameters. This creates a request for callback
    RM reply pattern*/
    public RequestDocument newRequest(String groupId, Calendar groupExpiryTime,
                                      long sequenceNumber, boolean lastMessage, 
                                      Calendar messageExpiryTime, 
                                      String replyPatternName,
                                      String replyTo);
  
    /** Creates a Request Document based on the specified mandatory 
    parameters with some optional parameters. This creates a request for callback 
    RM reply pattern*/
    public RequestDocument newRequest(String groupId, 
                                      GDuration groupMaxIdleDuration, 
                                      long sequenceNumber, boolean lastMessage, 
                                      Calendar messageExpiryTime, 
                                      String replyPatternName,
                                      String replyTo);
  
    /** Creates a PollRequest Document based on the specified parameters*/
    public PollRequestDocument newPollRequest(String groupId);
  
    /** Creates a PollRequest Document for one group which has set of reply ranges
    in Hashtable(from and to element pair)*/
    public PollRequestDocument newPollRequest(String groupId, Hashtable range);
  
    /** Creates a PollRequest Document for groups which has set of reply ranges
    in Hashtable(groupId and Hashtable of replyranges)*/
    public PollRequestDocument newPollRequest(Hashtable groupIds);
  
    /** Creates a PollRequest Document based on the specified parameters*/
    public PollRequestDocument newPollRequest(String[] groupId);
   
    /** Creates a PollRequest Document based on the specified parameters */
    public PollRequestDocument newPollRequest(String groupId, String replyTo);
  
    /** Creates a PollRequest Document based on the specified parameters */
    public PollRequestDocument newPollRequest(String[] groupId, String replyTo);
  
    /** Creates a PollRequest Document based on the specified parameters */
    public PollRequestDocument newPollRequest(String groupId, Hashtable range,
                                              String replyTo);
    /** Creates a PollRequest Document for groups which has set of reply ranges
    in Hashtable(groupId and Hashtable of replyranges)*/
    public PollRequestDocument newPollRequest(Hashtable groupIds, 
                                              String replyTo);
  
    /** Creates a simple ResponseDocument with single Response element*/
    public ResponseDocument newResponse();
  
    /** Adds a NonSequenceReply element(group with single message)To given 
    ResponseDocument.If fault is not present then it is acknowledgement 
    and if it present then it is fault*/
    public ResponseDocument newResponse(ResponseDocument responseDocument, 
                            String groupId, String fault);
  
    /** Adds a SequenceReply element(group with multiple messages)To given 
    ResponseDocument. Here Hashtable rangesAndFaultTable contains 
    ((Hashtable of ranges(from and to)) and (fault or ack)) pair*/
    public ResponseDocument newResponse(ResponseDocument responseDocument,
                            String groupId, Hashtable rangesAndFaultTable);
  
    /** Adds a SequenceReply element(group with multiple messages)To given 
    ResponseDocument with only one ReplyRange
    If fault is not present then it is acknowledgement 
    and if it present then it is fault*/
    public ResponseDocument newResponse(ResponseDocument responseDocument,
                            String groupId, long from, long to, String fault);
    
}
  
  